Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: allow jupyter notebooks in documentation #321

Merged
merged 30 commits into from
Apr 5, 2023
Merged

docs: allow jupyter notebooks in documentation #321

merged 30 commits into from
Apr 5, 2023

Conversation

hollandjg
Copy link
Member

@hollandjg hollandjg commented Mar 28, 2023 •
edited
Loading

Description

Integrate Jupyter notebooks into online documentation.

ToDo:

  • resolves Convert docs example to a Jupyter notebook #110
  • Add link to open on Colab
  • Add link to notebook location on GitHub (this could be possible using the edit_uri from the material for mkdocs theme)
  • Replace branch name docs/jupyter-in-documentation with main in main.html

Type of change

  • docs: Documentation only changes

Features

  • Replaced all .md files which were actually notebooks with working .ipynb notebooks.
  • Added link from documentation to open the corresponding notebook in Google Colaboratory.

Screenshots (Optional)

Screenshot 2023-03-29 at 14 18 48

Screenshot 2023-03-29 at 14 19 13

Screenshot 2023-03-28 at 12 23 26

@hollandjg hollandjg requested a review from musslick as a code owner March 28, 2023 16:24
@hollandjg hollandjg marked this pull request as draft March 28, 2023 17:37
hollandjg added 16 commits March 29, 2023 11:31
@hollandjg
docs: add "open in colab" link for notebook files
1b924bc
@hollandjg
docs: example.ipynb replaces example.md
00e79e1
@hollandjg
docs: search_space.ipynb replaces search_space.md
18e67d5
@hollandjg
docs: .ipynb replaces .md in nav
c858455
@hollandjg
docs: use file name as title
0f4a65c
@hollandjg
docs: break up sklearn directory in docs/examples – merge into theori…
a5d5a9c 
…st directories
@hollandjg
docs: replace darts example with notebook
a3a27cb
@hollandjg
Merge branch 'main' into docs/jupyter-in-documentation
b2b565a
@hollandjg
docs: replace hardcoded weber-fechner data with data from synthetic m…
2772ec0 
…odule
@hollandjg
docs: replace hardcoded weber-fechner data with data from synthetic m…
24a3c33 
…odule
@hollandjg
Merge remote-tracking branch 'origin/docs/jupyter-in-documentation' i…
59a2a4e 
…nto docs/jupyter-in-documentation
@hollandjg
chore: revert adding link to repo
9e9b648
@hollandjg
docs: update path to main branch
bce3c93
@hollandjg
docs: add colab import statements (commented out)
ac6b06b
@hollandjg
docs: fix imports in experimentalist pipeline examples
6d6df34
@hollandjg
docs: replace simple cycle BMS and poppernet example with notebook
8ca2add
@hollandjg hollandjg marked this pull request as ready for review March 29, 2023 18:21
chadcwilliams
chadcwilliams approved these changes Mar 29, 2023
View reviewed changes
Copy link
Collaborator

@chadcwilliams chadcwilliams left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great!

Only thing I wonder is if you think it would be useful to add a link within each notebook to itself on GitHub? These pages are read-only, but some users will definitely want to use the notebooks and play around with them. Adding a direct link to it might save them some time searching the repo for it.

Definitely very minor suggestion, and no problem if you're not interested. I will approve as is.

@hollandjg
Copy link
Member Author

hollandjg commented Mar 31, 2023 •
edited
Loading

Only thing I wonder is if you think it would be useful to add a link within each notebook to itself on GitHub? These pages are read-only, but some users will definitely want to use the notebooks and play around with them. Adding a direct link to it might save them some time searching the repo for it.

Yes, probably. I'll take a look.

@hollandjg
Copy link
Member Author

Hi @benwandrew and @musslick – the to-dos are finished on this PR now, and the BSR example has been merged as a notebook.

musslick
musslick approved these changes Apr 5, 2023
View reviewed changes
Copy link
Collaborator

@musslick musslick left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Quickly reviewed this, and it looks great to me. I'm foreseeing some merge conflicts with other open PRs (e.g., the experimentalist documentation), so probably best to get this merged ASAP, so we can build the other documentation on top.

benwandrew
benwandrew approved these changes Apr 5, 2023
View reviewed changes
Copy link
Collaborator

@benwandrew benwandrew left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

also looks good to me

@hollandjg hollandjg added this pull request to the merge queue Apr 5, 2023
Merged via the queue into main with commit 5f1feb1 Apr 5, 2023
@hollandjg hollandjg deleted the docs/jupyter-in-documentation branch April 5, 2023 19:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@musslick musslick musslick approved these changes

@chadcwilliams chadcwilliams chadcwilliams approved these changes

@benwandrew benwandrew benwandrew approved these changes

@gtdang gtdang Awaiting requested review from gtdang

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Convert docs example to a Jupyter notebook
4 participants
@hollandjg @musslick @chadcwilliams @benwandrew